[HybridWebView] Fix some issues with the interception, typescript and other features by mattleibow · Pull Request #29829 · dotnet/maui

mattleibow · 2025-06-04T21:26:50Z

This pull request introduces several improvements and fixes to the HybridWebView component, focusing on case-insensitive header handling, improving compatibility across platforms, refactoring JavaScript code, and enhancing testing. The most significant changes include updates to header dictionaries to support case-insensitivity, refactoring the JavaScript code for better readability and maintainability, and adding platform-specific compatibility checks in tests.

Case-insensitive header handling:

src/Controls/src/Core/HybridWebView/HybridWebViewWebResourceRequestedEventArgs.cs: Updated Headers and QueryParameters dictionaries to use StringComparer.OrdinalIgnoreCase and StringComparer.Ordinal, respectively, ensuring case-insensitive handling of headers and query parameters.
src/Controls/src/Core/HybridWebView/PlatformHybridWebViewWebResourceRequestedEventArgs.cs: Refactored GetRequestHeaders implementations across platforms to use StringComparer.OrdinalIgnoreCase for consistent case-insensitive header handling. [1] [2] [3]

JavaScript code refactoring:

src/Core/src/Handlers/HybridWebView/HybridWebView.js: Refactored JavaScript functions such as SendRawMessage, InvokeDotNet, and __InvokeJavaScript into standalone functions, and restructured the HybridWebView object for better readability and maintainability. Removed optional chaining for compatibility. [1] [2] [3] [4]

Platform-specific compatibility in tests:

src/Controls/tests/DeviceTests/Elements/HybridWebView/HybridWebViewTests.cs: Added checks to skip tests on older Android versions and certain platforms where features like custom schemes or HTTPS interception are not supported. Improved test logic for validating case-insensitive headers. [1] [2] [3]

TypeScript updates:

src/Core/src/Handlers/HybridWebView/HybridWebView.ts: Updated TypeScript code to remove optional chaining and ensure compatibility with platforms that do not support it.

These changes collectively enhance the HybridWebView component's functionality, improve cross-platform compatibility, and ensure robust testing practices.

Android: Observed lower case on some OS versions (ie 28) Windows: Header lookup is case insensitive macOS/iOS: CI will inform

Copilot

Pull Request Overview

This PR introduces a new test case to verify that the HybridWebView can intercept requests and read headers in a case-insensitive manner, addressing issues observed on various OS versions.

Added a new test method RequestsCanBeInterceptedAndCaseInsensitiveHeadersRead.
Incorporated conditional test data for different platforms based on header handling capabilities.

Comments suppressed due to low confidence (1)

src/Controls/tests/DeviceTests/Elements/HybridWebView/HybridWebViewTests.cs:771

[nitpick] Consider refactoring the repetitive try-catch blocks used for header value retrieval into a helper function or loop to reduce duplication and improve maintainability.

try { headerValues["X-Echo-Name"] = e.Headers["X-Echo-Name"]; }

mattleibow · 2025-06-04T21:27:03Z

/azp run

azure-pipelines · 2025-06-04T21:27:20Z

Azure Pipelines successfully started running 3 pipeline(s).

mattleibow · 2025-06-05T00:38:10Z

src/Controls/src/Core/HybridWebView/PlatformHybridWebViewWebResourceRequestedEventArgs.cs

-	internal IReadOnlyDictionary<string, string>? GetRequestHeaders() => new WrappedHeadersDictionary(Request.Headers);
-
-	class WrappedHeadersDictionary : IReadOnlyDictionary<string, string>


The previous way to use wrappers was me being "so clever" and "avoiding allocations" and "reducing copies"... But yeah, that was not sensible since the amount of things that would happen was so little. In order to hit this path, the user has to actually request the headers.

For all other cases, this doesn't do anything.

mattleibow · 2025-06-05T00:39:25Z

src/Controls/src/Core/HybridWebView/PlatformHybridWebViewWebResourceRequestedEventArgs.cs

+	internal IReadOnlyDictionary<string, string> GetRequestHeaders() =>
+		_headers ??= Request.RequestHeaders is { } rh
+			? new Dictionary<string, string>(rh, StringComparer.OrdinalIgnoreCase)
+			: new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);


Unfortunately, depending on the server and how the headers are populated, Android sometimes converts the headers to lower case. So we always will ned a case-insensitive.

Windows was already case insensitive, so this just makes it all consistent.

src/Core/src/Core.csproj

rmarinho

Tests now pass!

rmarinho

Talked too soon , seems still have some failure on API24, but it doesn t crash anymore

mattleibow · 2025-06-05T11:46:31Z

src/Core/src/Handlers/HybridWebView/HybridWebView.js

        }
        // Determine the mechanism to receive messages from the host application.
-        if (window.chrome?.webview?.addEventListener) {
+        if (window.chrome && window.chrome.webview && window.chrome.webview.addEventListener) {


The Android Chromeis weird. It suports async functions ahead of its time, but then also does not support ?.. I am at a loss.

rmarinho · 2025-06-05T17:45:39Z

/backport to release/10.0.1xx-preview5

github-actions · 2025-06-05T17:45:50Z

Started backporting to release/10.0.1xx-preview5: https://github.com/dotnet/maui/actions/runs/15473805094

rmarinho

Ok seems we are green now! Thanks @mattleibow

rmarinho · 2025-06-05T18:17:04Z

I backported but I also have this branch to just bring latest changes to the release branch .. go wild or go home

mattleibow · 2025-06-06T22:08:10Z

/backport to main

github-actions · 2025-06-06T22:08:20Z

Started backporting to main: https://github.com/dotnet/maui/actions/runs/15500641832

github-actions · 2025-06-06T22:08:40Z

@mattleibow backporting to "main" failed, the patch most likely resulted in conflicts:

$ git am --3way --empty=keep --ignore-whitespace --keep-non-patch changes.patch

Applying: Sometimes the OS changes the header casing
Using index info to reconstruct a base tree...
M	src/Controls/tests/DeviceTests/Elements/HybridWebView/HybridWebViewTests.cs
Falling back to patching base and 3-way merge...
Auto-merging src/Controls/tests/DeviceTests/Elements/HybridWebView/HybridWebViewTests.cs
CONFLICT (content): Merge conflict in src/Controls/tests/DeviceTests/Elements/HybridWebView/HybridWebViewTests.cs
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config set advice.mergeConflict false"
Patch failed at 0001 Sometimes the OS changes the header casing
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

Sometimes the OS changes the header casing

3e62577

Android: Observed lower case on some OS versions (ie 28) Windows: Header lookup is case insensitive macOS/iOS: CI will inform

Copilot AI review requested due to automatic review settings June 4, 2025 21:26

mattleibow requested a review from a team as a code owner June 4, 2025 21:26

mattleibow requested review from PureWeen and rmarinho June 4, 2025 21:26

Copilot AI reviewed Jun 4, 2025

View reviewed changes

fix some more issues

4382a77

mattleibow changed the title ~~[HybridWebView] Sometimes the OS changes the header casing~~ [HybridWebView] Fix some issues with the interception, typescript and other features Jun 5, 2025

mattleibow commented Jun 5, 2025

View reviewed changes

This should work... It was like this before

1567538

rmarinho approved these changes Jun 5, 2025

View reviewed changes

rmarinho requested changes Jun 5, 2025

View reviewed changes

mattleibow commented Jun 5, 2025

View reviewed changes

Better support for older devices and skip API 24

a9127d7

github-actions bot mentioned this pull request Jun 5, 2025

[release/10.0.1xx-preview5] [HybridWebView] Fix some issues with the interception, typescript and other features #29842

Merged

rmarinho approved these changes Jun 5, 2025

View reviewed changes

rmarinho merged commit e79ada6 into net10.0 Jun 5, 2025
125 of 130 checks passed

rmarinho deleted the dev/hybridwebview-header-case branch June 5, 2025 18:47

mattleibow mentioned this pull request Jun 6, 2025

[HybridWebView] Fix some issues with the typescript #29873

Merged

github-actions bot locked and limited conversation to collaborators Jul 7, 2025

		internal IReadOnlyDictionary<string, string>? GetRequestHeaders() => new WrappedHeadersDictionary(Request.Headers);

		class WrappedHeadersDictionary : IReadOnlyDictionary<string, string>

Conversation

mattleibow commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Case-insensitive header handling:

JavaScript code refactoring:

Platform-specific compatibility in tests:

TypeScript updates:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

mattleibow commented Jun 4, 2025

Uh oh!

azure-pipelines bot commented Jun 4, 2025

Uh oh!

mattleibow Jun 5, 2025

Choose a reason for hiding this comment

Uh oh!

mattleibow Jun 5, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rmarinho left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rmarinho left a comment

Choose a reason for hiding this comment

Uh oh!

mattleibow Jun 5, 2025

Choose a reason for hiding this comment

Uh oh!

rmarinho commented Jun 5, 2025

Uh oh!

github-actions bot commented Jun 5, 2025

Uh oh!

rmarinho left a comment

Choose a reason for hiding this comment

Uh oh!

rmarinho commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

mattleibow commented Jun 6, 2025

Uh oh!

github-actions bot commented Jun 6, 2025

Uh oh!

github-actions bot commented Jun 6, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mattleibow commented Jun 4, 2025 •

edited

Loading

rmarinho left a comment •

edited

Loading

rmarinho commented Jun 5, 2025 •

edited

Loading